Document current restrictions for property values. (#157409, Matthew H.

2004-11-04  Matthias Clasen  <mclasen@redhat.com>

	* gdk-pixbuf.c (gdk_pixbuf_class_init): Document current
	restrictions for property values.  (#157409, Matthew H. Plough)

diff --git a/gdk-pixbuf/ChangeLog b/gdk-pixbuf/ChangeLog
index 6a09eee8e62061cdb962b71a1f238de22698d7f4..80c95edbf0530f821bdaee224e7c1a589220e8c6 100644 (file)
--- a/gdk-pixbuf/ChangeLog
+++ b/gdk-pixbuf/ChangeLog
@@ -1,3 +1,8 @@
+2004-11-04  Matthias Clasen  <mclasen@redhat.com>
+
+       * gdk-pixbuf.c (gdk_pixbuf_class_init): Document current
+       restrictions for property values.  (#157409, Matthew H. Plough)
+
 2004-11-01  Matthias Clasen  <mclasen@redhat.com>
 
        * gdk-pixbuf-features.h.in: Break the declaration of the three 

diff --git a/gdk-pixbuf/gdk-pixbuf.c b/gdk-pixbuf/gdk-pixbuf.c
index 84d6cb2f342b6883d041c56a69325a2e937fe6ec..49da10782c1605afdb8545752b826dd9107935ca 100644 (file)
--- a/gdk-pixbuf/gdk-pixbuf.c
+++ b/gdk-pixbuf/gdk-pixbuf.c
@@ -96,6 +96,12 @@ gdk_pixbuf_class_init (GdkPixbufClass *klass)
         object_class->set_property = gdk_pixbuf_set_property;
         object_class->get_property = gdk_pixbuf_get_property;
         
+        /**
+         * GdkPixbuf:n-channels:
+         *
+         * The number of samples per pixel. 
+         * Currently, only 3 or 4 samples per pixel are supported.
+         */
         g_object_class_install_property (object_class,
                                          PROP_N_CHANNELS,
                                          g_param_spec_int ("n_channels",
@@ -127,6 +133,12 @@ gdk_pixbuf_class_init (GdkPixbufClass *klass)
                                                                G_PARAM_READWRITE |
                                                                G_PARAM_CONSTRUCT_ONLY));
 
+        /**
+         * GdkPixbuf:bits-per-sample:
+         *
+         * The number of bits per sample. 
+         * Currently only 8 bit per sample are supported.
+         */
         g_object_class_install_property (object_class,
                                          PROP_BITS_PER_SAMPLE,
                                          g_param_spec_int ("bits_per_sample",
@@ -160,6 +172,13 @@ gdk_pixbuf_class_init (GdkPixbufClass *klass)
                                                            G_PARAM_READWRITE |
                                                            G_PARAM_CONSTRUCT_ONLY));
 
+        /**
+         * GdkPixbuf:rowstride:
+         *
+         * The number of bytes between the start of a row and 
+         * the start of the next row. This number must (obviously)
+         * be at least as large as the width of the pixbuf.
+         */
         g_object_class_install_property (object_class,
                                          PROP_ROWSTRIDE,
                                          g_param_spec_int ("rowstride",